📝 Fix ambiguous phrasing regarding HeroPublicWithTeam model#1678
Open
berkaykrc wants to merge 1 commit intofastapi:mainfrom
Open
📝 Fix ambiguous phrasing regarding HeroPublicWithTeam model#1678berkaykrc wants to merge 1 commit intofastapi:mainfrom
HeroPublicWithTeam model#1678berkaykrc wants to merge 1 commit intofastapi:mainfrom
Conversation
Contributor
📝 Docs previewLast commit 9f5b872 at: https://eb71621d.sqlmodel.pages.dev Modified Pages |
YuriiMotov
changed the title
HeroPublicWithTeam model
YuriiMotov
approved these changes
Dec 24, 2025
Member
YuriiMotov
left a comment
YuriiMotov
left a comment
There was a problem hiding this comment.
@berkaykrc, thanks!
I agree this way it reads a bit easier.
We can also update the paragraph above:
- Now, notice that these new fields `team` and `heroes` are not declared with `Relationship()`, because these are not **table models**, they cannot have **relationship attributes** with the magic access to get that data from the database.
+ Now, notice that these new fields `team` and `heroes` are not declared with `Relationship()`, because `HeroPublicWithTeam` and `TeamPublicWithHeroes` are not **table models**, they cannot have **relationship attributes** with the magic access to get that data from the database.("these" replaced with explicit "HeroPublicWithTeam and TeamPublicWithHeroes")
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
I noticed a sentence in the Models with Relationships section that was slightly ambiguous and caused confusion about which model was being described.
In the paragraph discussing recursion, the text says:
Because the sentence omits the subject (the HeroPublicWithTeam class), it reads as if the text is describing a field inside TeamPublicWithHeroes, rather than explaining how the team field is typed inside the Hero model.
Changes
I have updated the text to explicitly state that we are looking at the HeroPublicWithTeam model.
Example of clarification:
This small change reduces cognitive load and prevents readers from looking for a logic error in TeamPublicWithHeroes.